﻿/*
AwpAdmin, an admin tool for Battlefield 3
Copyright (C) 2011 agentwite, Timi, Unseen, AlCapwn

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

You can contact us at http://bf3admin.codeplex.com/.
*/

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Text;
using System.Net.Battlefield3;

namespace AwpAdminTool
{
    /// <summary>
    /// Provides data for the <see cref="AwpAdmin.Command"/> event.
    /// </summary>
    [Serializable]
    public class CommandEventArgs : EventArgs
    {
        /// <summary>
        /// Gets the <see cref="Player"/> that sent the <see cref="Command"/>.
        /// </summary>
        /// <value>The <see cref="Player"/> that sent the <see cref="Command"/>.</value>
        public Player Player { get; private set; }

        /// <summary>
        /// Gets the <see cref="Admin"/> that send the <see cref="Command"/>.
        /// </summary>
        /// <value>The <see cref="Admin"/> that send the <see cref="Command"/>.</value>
        public Admin Admin { get; private set; }

        /// <summary>
        /// Gets the command that was received.
        /// </summary>
        /// <value>The command that was sent by the <see cref="Player"/>.</value>
        public string Command { get; private set; }

        /// <summary>
        /// Gets the space and quote-delimited parameters sent with the <see cref="Command"/>.
        /// </summary>
        /// <value>A <see cref="ReadOnlyCollection{String}"/> containing the parameters of the <see cref="Command"/>.</value>
        public ReadOnlyCollection<string> Parameters { get; private set; }

        /// <summary>
        /// Gets the parameters, with spaces and quotes intact, sent with the <see cref="Command"/>.
        /// </summary>
        /// <value>The full parameter string with all spaces left intact.</value>
        public string FullParameters { get; private set; }

        /// <summary>
        /// Gets the minimum required access level of the command.
        /// </summary>
        /// <value>The minimum required access level of the command.</value>
        public int AccessLevel { get; private set; }

        internal CommandEventArgs(Player player, string command, ReadOnlyCollection<string> parameters, string fullParameters, int accessLevel)
        {
            Player = player;
            Admin = player.GetAdmin();
            Command = command;
            Parameters = parameters;
            FullParameters = fullParameters;
            AccessLevel = accessLevel;
        }
    }
}
